# List Configuration

Defines custom SharePoint lists (non-document libraries) with columns and item management.

Referenced by: SiteCfg.Lists (nested array).

# Overview

ListCfg defines a custom SharePoint list (such as Tasks, Events, Contacts, or custom lists) with its columns, content types, and display settings.

# Applied when

Custom lists are created when:

The parent SiteCfg is provisioned and includes this list in the Lists array
Applied during site provisioning; lists are created after the site is created
All configured columns (Columns array) and content types are added to the list when it is created
If a referenced column or content type is not found, a warning is logged and provisioning continues without that item

# Core settings

# Name

Type: string | Required: Yes

Unique name for the list. Used internally to identify the list.

Example: "Tasks", "Events", "Contacts"

# Code

Type: string | Required: Yes

Code used in the URL (list URL segment). Must be unique within the site. No spaces or special characters.

Example: "tasks", "events"

# Title

Type: string | Required: No

Display name of the list shown in the UI. Defaults to Code if not specified.

Example: "Project Tasks", "Key Dates"

# Description

Type: string | Required: No

List description. Shown in site contents and list settings.

# TemplateType

Type: enum | Required: Yes

List template type. Determines the base list structure and available features.

Common types:

GenericList — Generic custom list
DocumentLibrary — Document library
Survey — Survey list
Links — Links to websites
Announcements — Announcements
Contacts — Contact information
Events — Calendar events
Tasks — Task tracking
DiscussionBoard — Discussion board
PictureLibrary — Picture library

# Content

# Columns

Type: string (list) | Required: No

Names of ColumnCfg entries to add to this list. Only applied if defined and not empty.

Each column reference is looked up in the site's configured columns. If a referenced column is not found, a warning is logged and provisioning continues without that column.

Example: ["Priority", "AssignedTo", "DueDate"]

Column Configuration — list columns
Site Configuration — lists within sites